icu_calendar
The icu_calendar
crate contains the core types used by ICU4X for dealing
with dates, times, and custom calendars.
The [types
] module has a lot of common types for dealing with dates and times.
[Calendar
] is a trait that allows one to define custom calendars, and [Date
]
can represent dates for arbitrary calendars.
The [iso
] and [gregorian
] modules contain implementations for the ISO and
Gregorian calendars respectively.
Some of the algorithms implemented here are based on Dershowitz, Nachum, and Edward M. Reingold. Calendrical calculations. Cambridge University Press, 2008. with associated Lisp code found at https://github.com/EdReingold/calendar-code2.
Examples
Examples of date manipulation using Date
object. Date
objects are useful
for working with dates, encompassing information about the day, month, year,
as well as the calendar type.
use ;
// Creating ISO date: 1992-09-02.
let mut date_iso = new_iso_date_from_integers.unwrap;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
// Answering questions about days in month and year.
assert_eq!;
assert_eq!;
// Advancing date in-place by 1 year, 2 months, 3 weeks, 4 days.
date_iso.add;
assert_eq!;
assert_eq!;
assert_eq!;
// Reverse date advancement.
date_iso.add;
assert_eq!;
assert_eq!;
assert_eq!;
// Creating ISO date: 2022-01-30.
let newer_date_iso = new_iso_date_from_integers.unwrap;
// Comparing dates: 2022-01-30 and 1992-09-02.
let duration = newer_date_iso.until;
assert_eq!;
assert_eq!;
assert_eq!;
// Create new date with date advancement. Reassign to new variable.
let mutated_date_iso = date_iso.added;
assert_eq!;
assert_eq!;
assert_eq!;
Example of converting an ISO date across Indian and Buddhist calendars.
use ;
// Creating ISO date: 1992-09-02.
let mut date_iso = new_iso_date_from_integers.unwrap;
assert_eq!;
assert_eq!;
assert_eq!;
// Conversion into Indian calendar: 1914-08-02.
let date_indian = date_iso.to_calendar;
assert_eq!;
assert_eq!;
assert_eq!;
// Conversion into Buddhist calendar: 2535-09-02.
let date_buddhist = date_iso.to_calendar;
assert_eq!;
assert_eq!;
assert_eq!;
Example using DateTime
object. Similar to Date
objects, DateTime
objects
contain an accessible Date
object containing information about the day, month,
year, and calendar type. Additionally, DateTime
objects contain an accessible
Time
object, including granularity of hour, minute, second, and nanosecond.
use ;
// Creating ISO date: 1992-09-02 8:59
let mut datetime_iso = new_iso_datetime_from_integers.unwrap;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
// Advancing date by 1 year, 2 months, 3 weeks, 4 days.
datetime_iso.date.add;
// New time of 14:30
datetime_iso.time = try_new.unwrap;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
assert_eq!;
More Information
For more information on development, authorship, contributing etc. please visit ICU4X home page
.